<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module phonenumbers.phonemetadata</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="phonenumbers.html"><font color="#ffffff">phonenumbers</font></a>.phonemetadata</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="https://github.com/daviddrysdale/python-phonenumbers/blob/dev/python/phonenumbers/phonemetadata.py">phonenumbers/phonemetadata.py</a></font></td></tr></table>
    <p><tt><a href="#PhoneMetadata">PhoneMetadata</a>&nbsp;object&nbsp;definitions</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="threading.html">threading</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="NumberFormat">class <strong>NumberFormat</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#NumberFormat">NumberFormat</a>(*__args,&nbsp;**__kwargs)<br>
&nbsp;<br>
Representation&nbsp;of&nbsp;way&nbsp;that&nbsp;a&nbsp;phone&nbsp;number&nbsp;can&nbsp;be&nbsp;formatted&nbsp;for&nbsp;output<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="NumberFormat-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self==value.</tt></dd></dl>

<dl><dt><a name="NumberFormat-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>

<dl><dt><a name="NumberFormat-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self!=value.</tt></dd></dl>

<dl><dt><a name="NumberFormat-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>

<dl><dt><a name="NumberFormat-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>

<dl><dt><a name="NumberFormat-merge_from"><strong>merge_from</strong></a>(self, other)</dt><dd><tt>Merge&nbsp;information&nbsp;from&nbsp;another&nbsp;<a href="#NumberFormat">NumberFormat</a>&nbsp;object&nbsp;into&nbsp;this&nbsp;one.</tt></dd></dl>

<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>

<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="NumberFormat-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return&nbsp;str(self).</tt></dd></dl>

<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="NumberFormat-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement&nbsp;delattr(self,&nbsp;name).</tt></dd></dl>

<dl><dt><a name="NumberFormat-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement&nbsp;setattr(self,&nbsp;name,&nbsp;value).</tt></dd></dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="PhoneMetadata">class <strong>PhoneMetadata</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#PhoneMetadata">PhoneMetadata</a>(*__args,&nbsp;**__kwargs)<br>
&nbsp;<br>
Class&nbsp;representing&nbsp;metadata&nbsp;for&nbsp;international&nbsp;telephone&nbsp;numbers&nbsp;for&nbsp;a&nbsp;region.<br>
&nbsp;<br>
This&nbsp;class&nbsp;is&nbsp;hand&nbsp;created&nbsp;based&nbsp;on&nbsp;phonemetadata.proto.&nbsp;Please&nbsp;refer&nbsp;to&nbsp;that&nbsp;file<br>
for&nbsp;detailed&nbsp;descriptions&nbsp;of&nbsp;the&nbsp;meaning&nbsp;of&nbsp;each&nbsp;field.<br>
&nbsp;<br>
WARNING:&nbsp;This&nbsp;API&nbsp;isn't&nbsp;stable.&nbsp;It&nbsp;is&nbsp;considered&nbsp;libphonenumber-internal<br>
and&nbsp;can&nbsp;change&nbsp;at&nbsp;any&nbsp;time.&nbsp;We&nbsp;only&nbsp;declare&nbsp;it&nbsp;as&nbsp;public&nbsp;for&nbsp;easy<br>
inclusion&nbsp;in&nbsp;our&nbsp;build&nbsp;tools&nbsp;not&nbsp;in&nbsp;this&nbsp;package.&nbsp;&nbsp;Clients&nbsp;should&nbsp;not<br>
refer&nbsp;to&nbsp;this&nbsp;file,&nbsp;we&nbsp;do&nbsp;not&nbsp;commit&nbsp;to&nbsp;support&nbsp;backwards-compatibility&nbsp;or<br>
to&nbsp;warn&nbsp;about&nbsp;breaking&nbsp;changes.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PhoneMetadata-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self==value.</tt></dd></dl>

<dl><dt><a name="PhoneMetadata-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>

<dl><dt><a name="PhoneMetadata-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self!=value.</tt></dd></dl>

<dl><dt><a name="PhoneMetadata-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>

<dl><dt><a name="PhoneMetadata-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>

<hr>
Class methods defined here:<br>
<dl><dt><a name="PhoneMetadata-load_all"><strong>load_all</strong></a>()<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt><dd><tt>Force&nbsp;immediate&nbsp;load&nbsp;of&nbsp;all&nbsp;metadata</tt></dd></dl>

<dl><dt><a name="PhoneMetadata-metadata_for_nongeo_region"><strong>metadata_for_nongeo_region</strong></a>(country_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-metadata_for_region"><strong>metadata_for_region</strong></a>(region_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-metadata_for_region_or_calling_code"><strong>metadata_for_region_or_calling_code</strong></a>(country_calling_code, region_code)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-register_nongeo_region_loader"><strong>register_nongeo_region_loader</strong></a>(country_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-register_region_loader"><strong>register_region_loader</strong></a>(region_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-register_short_region_loader"><strong>register_short_region_loader</strong></a>(region_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<dl><dt><a name="PhoneMetadata-short_metadata_for_region"><strong>short_metadata_for_region</strong></a>(region_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>

<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>

<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="PhoneMetadata-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return&nbsp;str(self).</tt></dd></dl>

<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="PhoneMetadata-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement&nbsp;delattr(self,&nbsp;name).</tt></dd></dl>

<dl><dt><a name="PhoneMetadata-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement&nbsp;setattr(self,&nbsp;name,&nbsp;value).</tt></dd></dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="PhoneNumberDesc">class <strong>PhoneNumberDesc</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#PhoneNumberDesc">PhoneNumberDesc</a>(*__args,&nbsp;**__kwargs)<br>
&nbsp;<br>
Class&nbsp;representing&nbsp;the&nbsp;description&nbsp;of&nbsp;a&nbsp;set&nbsp;of&nbsp;phone&nbsp;numbers.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PhoneNumberDesc-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self==value.</tt></dd></dl>

<dl><dt><a name="PhoneNumberDesc-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>

<dl><dt><a name="PhoneNumberDesc-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return&nbsp;self!=value.</tt></dd></dl>

<dl><dt><a name="PhoneNumberDesc-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>

<dl><dt><a name="PhoneNumberDesc-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>

<dl><dt><a name="PhoneNumberDesc-merge_from"><strong>merge_from</strong></a>(self, other)</dt><dd><tt>Merge&nbsp;information&nbsp;from&nbsp;another&nbsp;<a href="#PhoneNumberDesc">PhoneNumberDesc</a>&nbsp;object&nbsp;into&nbsp;this&nbsp;one.</tt></dd></dl>

<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>

<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="PhoneNumberDesc-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return&nbsp;str(self).</tt></dd></dl>

<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="PhoneNumberDesc-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement&nbsp;delattr(self,&nbsp;name).</tt></dd></dl>

<dl><dt><a name="PhoneNumberDesc-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement&nbsp;setattr(self,&nbsp;name,&nbsp;value).</tt></dd></dl>

</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>REGION_CODE_FOR_NON_GEO_ENTITY</strong> = '001'</td></tr></table>
</body></html>